Resource Path: /api/submit/{id}
Uri: http://doc.jamsscheduler.com/api/submit/{id}
Description
Get the submit info for a Job with the specified ID
Parameters
Name | Description | Data Type |
id | The ID of the Job. | integer |
Response
The response body is of type SubmitInfo.
OK
Overview
 |
SubmitInfo
 |
afterTimeUTC : string
|
 |
allowEditSource : boolean
|
 |
batchQueueID : integer
|
 |
batchQueueName : string
|
 |
debugMode : boolean
|
 |
description : string
|
 |
 |
elementName : string
|
 |
elementTypeName : string
|
 |
elementTypeId : integer
|
 |
elementId : integer
|
 |
elementUid : string
|
 |
ownerUid : string
|
 |
inherited : boolean
|
 |
inheritedFromType : string
|
 |
inheritedFromId : integer
|
 |
inheritedFromName : string
|
 |
elementKind : string
|
 |
elementState : string
|
 |
 |
propertyName : string
|
 |
categoryName : string
|
 |
categorySortOrder : integer
|
 |
displayName : string
|
 |
propertyId : integer
|
 |
typeName : string
|
 |
typeNameSSO : string
|
 |
toolTip : string
|
 |
description : string
|
 |
editor : string
|
 |
mergeOption : string
|
 |
sortOrder : integer
|
 |
inheritedFromType : string
|
 |
inheritedFromId : integer
|
 |
inheritedFromName : string
|
 |
readOnly : boolean
|
 |
browsable : boolean
|
 |
defaultValue : object
|
 |
currentValue : object
|
|
 |
writeToEntry : boolean
|
 |
writeToHistory : boolean
|
 |
tabName : string
|
 |
sortOrder : integer
|
 |
validateTypeNameSSO : string
|
 |
formatString : string
|
 |
addMenuText : string
|
 |
categoryName : string
|
 |
categoryAddMenuText : string
|
 |
categorySortOrder : integer
|
|
 |
editAssemblyName : string
|
 |
editClassName : string
|
 |
extension : string
|
 |
failShort : boolean
|
 |
folderID : integer
|
 |
folderName : string
|
 |
hold : boolean
|
 |
jamsEntry : integer
|
 |
jamsId : string
|
 |
logFilename : string
|
 |
logLocation : string
|
 |
manageAccess : boolean
|
 |
missedWindowAction : string
|
 |
name : string
|
 |
note : string
|
 |
notifyOfMissedWindow : boolean
|
 |
overrideName : string
|
 |
 |
allowEntry : boolean
|
 |
dataType : string
|
 |
defaultFormat : string
|
 |
parameterGroup : string
|
 |
uniqueId : integer
|
 |
helpText : string
|
 |
hide : boolean
|
 |
length : integer
|
 |
mustFill : boolean
|
 |
parameterOrigin : string
|
 |
paramID : integer
|
 |
paramName : string
|
 |
paramValue : string
|
 |
prompt : string
|
 |
required : boolean
|
 |
uppercase : boolean
|
 |
validationData : string
|
 |
validationType : string
|
 |
encryptionId : integer
|
|
 |
 |
totalSeconds : integer
|
|
 |
precheckJobID : integer
|
 |
 |
propertyName : string
|
 |
categoryName : string
|
 |
categorySortOrder : integer
|
 |
displayName : string
|
 |
propertyId : integer
|
 |
typeName : string
|
 |
typeNameSSO : string
|
 |
toolTip : string
|
 |
description : string
|
 |
editor : string
|
 |
mergeOption : string
|
 |
sortOrder : integer
|
 |
inheritedFromType : string
|
 |
inheritedFromId : integer
|
 |
inheritedFromName : string
|
 |
readOnly : boolean
|
 |
browsable : boolean
|
 |
defaultValue : object
|
 |
currentValue : object
|
|
 |
restartable : boolean
|
 |
resultText : string
|
 |
retainOption : string
|
 |
 |
totalSeconds : integer
|
|
 |
ron : integer
|
 |
 |
totalSeconds : integer
|
|
 |
 |
totalSeconds : integer
|
|
 |
 |
totalSeconds : integer
|
|
 |
scheduleWindowID : integer
|
 |
schedulingPriority : integer
|
 |
setSymbols : boolean
|
 |
 |
totalSeconds : integer
|
|
 |
source : string
|
 |
 |
elementName : string
|
 |
elementTypeName : string
|
 |
elementTypeId : integer
|
 |
elementId : integer
|
 |
elementUid : string
|
 |
ownerUid : string
|
 |
inherited : boolean
|
 |
inheritedFromType : string
|
 |
inheritedFromId : integer
|
 |
inheritedFromName : string
|
 |
elementKind : string
|
 |
elementState : string
|
 |
 |
propertyName : string
|
 |
categoryName : string
|
 |
categorySortOrder : integer
|
 |
displayName : string
|
 |
propertyId : integer
|
 |
typeName : string
|
 |
typeNameSSO : string
|
 |
toolTip : string
|
 |
description : string
|
 |
editor : string
|
 |
mergeOption : string
|
 |
sortOrder : integer
|
 |
inheritedFromType : string
|
 |
inheritedFromId : integer
|
 |
inheritedFromName : string
|
 |
readOnly : boolean
|
 |
browsable : boolean
|
 |
defaultValue : object
|
 |
currentValue : object
|
|
 |
writeToEntry : boolean
|
 |
writeToHistory : boolean
|
 |
tabName : string
|
 |
sortOrder : integer
|
 |
validateTypeNameSSO : string
|
 |
formatString : string
|
 |
addMenuText : string
|
 |
categoryName : string
|
 |
categoryAddMenuText : string
|
 |
categorySortOrder : integer
|
|
 |
 |
totalSeconds : integer
|
|
 |
submitID : integer
|
 |
submitIsSimple : boolean
|
 |
submittedBy : string
|
 |
suppressNotify : boolean
|
 |
testSubmit : boolean
|
 |
timestampLogs : boolean
|
 |
userID : integer
|
 |
useSymbols : boolean
|
 |
tagIds : Array[]
|
 |
 |
tagId : integer
|
 |
tagName : string
|
|
 |
inheritedTagIds : Array[]
|
|
See Also